home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 4 / The 640 Meg Shareware Studio CD-ROM Volume IV (Data Express)(1994).ISO / clang / ncdc151.zip / NCDC.DOC < prev    next >
Text File  |  1993-05-01  |  8KB  |  233 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.                                N C D C
  11.  
  12.  
  13.                              version  1.51
  14.  
  15.                           Jurgen A. Doornik
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.     1. Introduction.
  26.     ___________________________________________________________________
  27.  
  28.     NCDC is a XX/UU encoder/decoder. There are many of these around,
  29.     so why NCDC?
  30.  
  31.     o  NCDC is completely free, and comes with C source code.
  32.  
  33.     o  NCDC is written in ANSI C, with conditional code sections
  34.        for old style (K&R) headers, Unix and VAX/VMS.
  35.        NCDC currently runs on MsDos, Unix, and VAX/VMS computers.
  36.        You can easily adjust the source code for other machines,
  37.        but it will probably run unchanged.
  38.  
  39.     o  NCDC has the decoder and encoder in one program, and
  40.        is fairly intelligent: it knows when to decode or encode,
  41.        and, when decoding, which method to use.
  42.  
  43.     o  Unlike many other decoders, NCDC gives warning messages
  44.        if something unexpected is found. NCDC can glue broken lines.
  45.  
  46.     o  NCDC is efficient. Its speed approximates that of assembler
  47.        encoders/decoders.
  48.  
  49.  
  50.     If you have any suggestions for improvement, or find any bugs,
  51.     please report them to me, via email:
  52.  
  53.        INTERNET: ECONZ@UK.AC.OX.VAX
  54.  
  55.     or by mail:
  56.  
  57.     Jurgen Doornik
  58.     Institute of Economics and Statistics
  59.     St Cross Building, Manor Road
  60.     Oxford OX1 3UL
  61.     United Kingdom
  62.     FAX +44 - 865 - 271094
  63.  
  64.     Special thanks are due to Arjen Merckens, who helped debugging
  65.     NCDC, and added the /s option for VAX/VMS. Arjen is author
  66.     of ACD (ChDir FAST; more features than LCD/NCD and free).
  67.  
  68.  
  69.     2. Contents of zip file.
  70.     ___________________________________________________________________
  71.  
  72.     NCDC.C   - C source code for NCDC
  73.     NCDC.DOC - this file
  74.     NCDC.EXE - Dos executable
  75.     NCDC.VXE - VAX/VMS executable
  76.  
  77.  
  78.     3. Installation and compilation
  79.     ___________________________________________________________________
  80.  
  81.     To install the VAX/VMS executable, you need to transfer it (as a
  82.     binary file) to the VAX, rename it to NCDC.EXE, and add something
  83.     like
  84.         $NCDC == "$disk:[path]NCDC.EXE"
  85.     to your login.com. To compile on the VAX type
  86.         CC NCDC.C
  87.     and then
  88.         LINK NCDC
  89.     I had to add
  90.         $ define LNK$LIBRARY  "SYS$LIBRARY:VAXCRTL"
  91.     to my login.com for this to work.
  92.  
  93.     The Dos version is compiled and linked using Microsoft C/C++ 7.00,
  94.     using the command
  95.         CL NCDC.C
  96.     So no extra optimizations were used.
  97.  
  98.  
  99.     4. How to use NCDC.
  100.     ___________________________________________________________________
  101.  
  102.     Usage:  NCDC infile [outfile] [/u] [/##]
  103.  
  104.     infile   The file to encode or decode.
  105.              NCDC decodes if infile has no extension or
  106.              an extension ENC, XXE or UUE. Otherwise NCDC
  107.              will encode. When decoding, the decoding method
  108.              is derived from first encoded line of infile.
  109.              When encoding XXencoding is the default.
  110.  
  111.     outfile  Optionally override the destination. This is
  112.              useful when the name of the original file which
  113.              has been encoded, is invalid on the decoding
  114.              platform.
  115.  
  116.     /u       Set encoding method to UUencode.
  117.  
  118.     /##      Sets maximum outfile size to ## kilobytes. E.g.
  119.                  NCDC test.zip /50
  120.              could lead to test.enc, test.en2 and test.en3
  121.              being created. If you then do
  122.                  NCDC test
  123.              NCDC will see that test.enc is not enough, and
  124.              automatically include test.en2 and test.en3.
  125.  
  126.     /s       This option is only available under VAX/VMS.
  127.              By default the decoded file has Variable length format.
  128.              Use /s to change this to Stream_LF format.
  129.  
  130.  
  131.     5. When to use NCDC.
  132.     ___________________________________________________________________
  133.  
  134.     Executable files, and word processor files cannot be sent by email
  135.     as such. They have to be encoded on one side, and decoded on the
  136.     other side to make sure that no information is lost.
  137.     Email often involves several types of computers, leading to several
  138.     conversions into other character coding systems.
  139.  
  140.     An email transmission of a document usually works like this:
  141.     1. compress the document              <----  PKZIP,ARJ,ZOO,LHARC, etc
  142.     2. encode the document                <----  NCDC
  143.     3. send it to the mainframe
  144.     3. email the document
  145.          .....
  146.     4. document is received
  147.     5. download it from the mainframe
  148.     6. decode the document                <----  NCDC
  149.     7. decompress the document            <----  PKUNZIP,ARJ,ZOO,LHARC, etc
  150.  
  151.     To send test.doc, for example:
  152.     1. PKZIP test.doc
  153.     2. NCDC test.zip             <---- XXencode file test.zip into test.enc
  154.         .....
  155.     6. NCDC test                 <---- XXdecode file test.enc into test.zip
  156.     7. PKUNZIP test
  157.  
  158.     Altough steps 1 and 7 are optional, they are advisable in order to
  159.     keep network transmissions at a minimum.
  160.  
  161.  
  162.  
  163.     6. License, warranty and disclaimer.
  164.     ___________________________________________________________________
  165.  
  166.     NCDC is written by Jurgen A. Doornik in ANSI C. Some special
  167.     additions are made for VAX/VMS and UNIX machines.
  168.     You may distribute NCDC given these restrictions:
  169.  
  170.     o  the program shall be supplied in its original, unmodified
  171.        form, which includes this documentation;
  172.  
  173.     o  no fee is charged;
  174.  
  175.     o  the program may be included, or bundled, with any other
  176.        programs/products (including for-profit products) on the
  177.        condition that I shall receive one copy of the program/
  178.        product (as given/sold), and an update each time NCDC
  179.        is bundled with the update.
  180.  
  181.     o  You may use and modify the source code for personal pur-
  182.        poses only, and on the condition that I shall receive
  183.        a copy of the modified version.
  184.  
  185.     For any other use contact me.
  186.  
  187.  
  188.  
  189.     Jurgen Doornik        INTERNET: ECONZ@UK.AC.OX.VAX
  190.  
  191.     Institute of Economics and Statistics
  192.     St Cross Building, Manor Road
  193.     Oxford OX1 3UL
  194.     United Kingdom
  195.     FAX +44 - 865 - 271094
  196.  
  197.  
  198.     DISCLAIMER:
  199.     I shall not be responsible for any damages or inconveniences
  200.     incurred due to the usage of NCDC.
  201.  
  202.     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW WILL JURGEN DOORNIK BE
  203.     LIABLE TO YOU FOR DAMAGES, INCLUDING ANY LOST PROFITS, LOST MONIES, OR
  204.     OTHER SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
  205.     USE OR INABILITY TO USE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR
  206.     DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY THIRD PARTIES)
  207.     THESE PROGRAMS, EVEN IF YOU HAVE BEEN ADVISED OF THE POSSIBILITY OF
  208.     SUCH DAMAGES, OR FOR ANY CLAIM BY ANY OTHER PARTY.
  209.  
  210.  
  211.     7. Revision history.
  212.     ___________________________________________________________________
  213.  
  214.     26-10-92 (JAD): Released version 1.51.
  215.     26-10-92 (JAD): Pre/post encoding text used \n instead of
  216.              \r\n for MSDOS.
  217.     04-08-92 (JAD): Released version 1.5.
  218.     08-04-92 (JAD): VMS specific help text restricted to VMS.
  219.              Documented NCDC.
  220.     01-05-91 (AM): added smaller buffer for VMS; added /s option:
  221.              Stream_LF decoding for VMS.
  222.     10-04-91 (JAD): added osize = 0 in decode; added get_start()
  223.              because continuation files received from SIMTEL don't
  224.              start with begin. When decodeing was expecting multiple
  225.              of four in last line, now computes # actually expected
  226.              (when encoding still writing multiple of four.
  227.      9-04-91 (JAD): changed VMS OPEN_W_ARG, added pre-ANSI C function
  228.              headers for UNIX.
  229.      8-04-91 (JAD): Introduced MSDOS/VMS/UNIX versions.
  230.      4-04-91 (JAD): Bug fix: table was not kept when found at top of
  231.              encoded file.
  232.  
  233.